IBM Endpoint Manager Inspectors Reference

Terminology

Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile

The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.

Platform


Contents

Action Objects
Authorization Objects
Client Objects
Directory Services
Environment Objects
Filesystem Objects
Firewall Objects
Fixlet Objects
Formatting Objects
Installed System Software
Introspectors
License Objects
Microsoft IIS Metabase Objects
Miscellaneous
Networking Objects
Power Objects
Primitive Objects
Registry Objects
Session Objects
Session Statistics
Site Objects
SMBIOS objects
System Objects
Task Objects
User Objects
activity history
logged on user
user
user attribute
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

User Objects

These Inspectors return information about local and current user accounts, including names, logins, passwords and more.

user

The <user> Inspectors allow you to list properties of all users, whether they are logged in or not.

Creation Methods

DeclarationDescriptionPlatforms (?)
local user <string>Returns the Active Directory local user object for the specified local user. This allows inspection of AD properties for that user, whether cached or currently logged in.Win:8.1, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
userReturns objects for all users of the computer, logged in or not.Win:8.1, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
user <string>Returns the user specified by <string>.Win:8.1, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
effective user of <process>Returns the effective user of the process specifiedUbu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0
user of <logged on user>Returns a user object from a 'logged on' user. This is for Active Directory expressions to bridge the gaps between user types. This retains the domain information of the logged on user within the user object where other user types might not.Win:8.1, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.1, Ubu:8.2

Properties

DeclarationReturn typeDescriptionPlatforms (?)
name of <user><string>

Plural: names		Returns the name of all specified users, whether logged on or not. On Linux or UNIX platforms, returns the name of all logged on users.Win:8.1, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tty of <user><string>

Plural: ttys		Returns the tty of the user.Lin, Sol, HPUX, AIX, Ubu:8.1

logged on user

These Windows and Macintosh Inspectors return information about the currently logged-on user. With the advent of Terminal Services and Fast User Switching, these Inspectors are designed to iterate over all logged on users. Windows Note: If Terminal Services are available (NT/2000/2003/XP/Vista) and enabled, these Inspectors iterate over the active and disconnected sessions as returned by WTSEnumerateSessions. Disconnected sessions are those where a user logs on, but is currently inactive. On Vista, the non-interactive session 0 (used for services isolation) is not included. If Terminal Services aren't available, the ACLs on the security descriptor of the "winsta0" window station are examined for user logons. On Windows 9x systems, these Inspectors return the user session associated with the registry value "Current User" of "SYSTEM\CurrentControlSet\Control" if it exists. Otherwise, if a shell process process such as Explorer.exe is running, they return a single session associated with an unnamed user (which occurs when the user cancels the 9x login dialog).

Creation Methods

DeclarationDescriptionPlatforms (?)
current userReturns the active, console (local) user, if logged on. Otherwise does not exist.

Example: name of current user = "bigfix" - Returns true if BigFix is the current user object.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
logged on userReturns zero or more users logged on to this computer. This Inspector iterates through all logged-on users, using Fast User Switching, Terminal Services, ACLs, and on Win 9x, the registry.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac, WM, Ubu:8.2

Properties

DeclarationReturn typeDescriptionPlatforms (?)
active of <logged on user><boolean>

Plural: actives		Returns TRUE if the specified user session is active (either as a current Fast User or an active terminal services connection).Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac, WM, Ubu:8.2
name of <logged on user><string>

Plural: names		If Terminal Services is available and enabled under NT4/2000/2003/XP/Vista, this Inspector returns the result of WTSQuerySessionInformation with WTSUserName. With Terminal Services disabled, it examines the ACLs on the security descriptor of the "winsta0" window station. Under Windows 9x, returns the "Current User" of "SYSTEM\CurrentControlSet\Control" if it exists. Otherwise returns No Such Object.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, WM, Ubu:8.2
process id of <logged on user><integer>

Plural: process ids		Returns the process id number for the base session process for logged on users, usually the session manager.Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
remote of <logged on user><boolean>

Plural: remotes		Returns TRUE if the user session is a remote terminal services connection.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac, WM, Ubu:8.2
tty of <logged on user><string>

Plural: ttys		Returns the name of the connection the user is on. Result is platform specific. Examples are: "Console", "RDP-Tcp#0", "pts/1", ":0"Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
user of <logged on user><user>

Plural: users		Returns a user object from a 'logged on' user. This is for Active Directory expressions to bridge the gaps between user types. This retains the domain information of the logged on user within the user object where other user types might not.Win:8.1, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.1, Ubu:8.2

user attribute

These Macintosh Inspectors provide information, such as user ID and home directory, about the specified user.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

activity history

The <activity history> Inspectors keep track of the activity of a single logged-on user. You may iterate over all logged-on users and get the history for each user separately. User information is purged at log off and power off/client off, even if the user immediately logs back in. These Inspectors retrieve information within a tracking window (defaulting to 14 days) or, if the window is still open, the start of that window. Information is in the form of a list of (interval, state) tuples. The first element of the list is the current state of the system. The event lists are fetched from the client each time 'activity history' is referenced, so you should avoid referencing these Inspectors more than once in a relevance statement. Note: Activity tracking only works while the Client UI is running. These Inspectors only work with Windows 2000 or better.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)